Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@material/elevation

Package Overview
Dependencies
Maintainers
9
Versions
1676
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@material/elevation

Material Components for the web mixins + CSS Classes for Material Design elevation

  • 0.1.13
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
498K
decreased by-43.7%
Maintainers
9
Weekly downloads
 
Created
Source

Elevation

Shadows provide important visual cues about objects’ depth and directional movement. They are the only visual cue indicating the amount of separation between surfaces. An object’s elevation determines the appearance of its shadow. The elevation values are mapped out in a "z-space" and range from 0 to 24.

A note about "z-space": Within the spec, elevation is normally referred to as having a dp value. In other words, how many "pixels" above the base material is a piece of material elevated. On a computer, this is normally represented by a 3-d coordinate system. We like z-space (or just "z" for short) because it aligns with the technical definition of, and nomenclature for, a 3-d coordinate system. Therefore, we feel it makes more sense than dp. However, when we refer to z-space (or z), that can be used interchangeably with the spec's dp.

Design & API Documentation

  • Material Design guidelines: Shadows & elevation
  • Demo

Installation

npm install --save @material/elevation

Usage

CSS Classes

Some components have a set elevation. For example, a raised MDC Button has elevation 2.

If you want to set the elevation of an element, which is not a Material Design component, you can apply the following CSS classes.

CSS ClassDescription
mdc-elevation--z<N>Sets the elevation to the (N)dp, where 1 <= N <= 24
mdc-elevation-transitionApplies the correct css rules to transition an element between elevations

Sass Mixins, Variables, and Functions

MixinDescription
mdc-elevation($z-value)Sets the elevation to the z-space for that given elevation
mdc-elevation-transition($duration, $easing)Applies the correct css rules to transition an element between elevations
VariableDescription
mdc-elevation-transition-durationDefault duration value for elevation transitions
mdc-elevation-transition-timing-functionDefault easing value for elevation transitions

If you need more configurability over your transitions, use the mdc-elevation-transition-rule function in conjunction with the exported sass variables.

.my-component-with-custom-transitions {

  transition:
    mdc-elevation-transition-rule(),
    /* Configure opacity to use same duration and easing values as elevation */
    opacity $mdc-elevation-transition-duration $mdc-elevation-transition-timing-function;
  opacity: .7;
  will-change: $mdc-elevation-property, opacity;
}

Keywords

FAQs

Package last updated on 02 Oct 2017

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc